Skip to main content

First release of documentation

· 3 min read
Vitaliy Domnich

The first release of documentation for using the RISDK library for interacting with electronic components and peripherals has been released.

List of all functionality provided by the RISDK library:

  • Basic API:
    • SDK initialization function,
    • SDK destructor,
    • Base component creation function,
    • The function of creating a group component,
    • Device component creation function,
    • The function of creating a model component,
    • component destructor,
    • Connect LED to controller,
    • PWM connection to the controller,
    • Connecting the servo to the controller.
  • Connector API:
    • Group component extension function,
  • Executive device API:
    • Group component extension function,
    • Read state function.
  • I2C adapter API:
    • Group component extension function,
    • Model expansion function,
    • The function of establishing a connection to a given address,
    • Read state status function,
    • The function of reading an array of bytes from an address,
    • The function of writing an array of bytes to addresses,
    • Function to read a byte from an address,
    • The function of writing a byte to an address,
    • Connection close function,
    • The function of closing all connections.
  • PWM API:
    • Group component extension function,
    • Model expansion function,
    • PWM enable function,
    • PWM frequency receiving function,
    • PWM frequency setting function,
    • Port frequency receiving function,
    • Port frequency setting function,
    • Duty cycle setting function,
    • Duty cycle receiving function,
    • Port frequency reset function,
    • All ports frequency reset function,
    • The function of reading an array of bytes from the register,
    • The function of writing an array of bytes to a register,
    • Function to read a byte from a register,
    • The function of writing a byte to a register,
    • Destructor.
  • Servo API:
    • Model expansion function,
    • Custom servo initialization,
    • Group component extension function,
    • Action stop function,
    • Function of rotation on the minimum step,
    • Rotate function,
    • The function of turning by a given number of steps,
    • Rotate function with given impulse,
    • Rotation function,
    • Relative speed rotation function,
    • Relative speed turning function,
    • Function of reading the current angle,
    • Function of getting state.
  • LED API:
    • Model expansion function,
    • Group component extension function,
    • Action stop function,
    • Continuous light function,
    • Function of flashing at a given frequency,
    • Function of flashing with a given pause,
    • Flicker function,
    • Glow color reading function,
    • Function of getting state.